Associates an arbitrary piece of data with a window.

OSStatus SetWindowProperty (
    WindowRef window, 
    PropertyCreator propertyCreator, 
    PropertyTag propertyTag, 
    UInt32 propertySize, 
    void *propertyBuffer
);

window

A pointer to the window with which data is to be associated.

propertyCreator

The creator code (typically, the application’s signature) of the data to be associated.

propertyTag

A value identifying the data to be associated. You define the tag your application uses to identify the data; this code is not to be confused with the file type for the data.

propertySize

The size of the data to be associated.

propertyBuffer

A pointer to the data to be associated.

function result

A result code.

DISCUSSION

Data set with the SetWindowProperty function may be obtained with the function GetWindowProperty and removed with the function RemoveWindowProperty.

VERSION NOTES

This function is available with Mac OS 8.5 and later.

AVAILABILITY

Supported in Carbon. Available in CarbonLib 1.0 and later when WindowsLib 8.5 or later is installed. Exported by CarbonLib 1.0 and later and by WindowsLib 8.5 and later.

© 2000 Apple Computer, Inc. — (Last Updated 4/14/2000)